doc: Added fundchannel man page. - #1463
Conversation
ZmnSCPxj
left a comment
There was a problem hiding this comment.
Some nits, also request to change formatting slightly.
| ----------- | ||
| The *fundchannel* RPC command opens a payment channel with a peer by commiting | ||
| a funding transaction to the blockchain as defined in BOLT #2. Once the | ||
| transaction is confirmed, normal channel operations may begin. Readiness is |
There was a problem hiding this comment.
Suggest adding newlines at end of sentence. That way, even if an earlier sentence is later amended, only that sentence needs to be reformatted and later sentences in the same paragraph need not be affected. E.g.
The *fundchannel* RPC command opens a payment channel with a peer by commiting
a funding transaction to the blockchain as defined in BOLT #2.
Once the transaction is confirmed, normal channel operations may begin.
Readiness is indicated by *listfunds* reporting a `short_channel_id` for
the channel.
Then later if we amend it:
The *fundchannel* RPC is a totally radical command that opens a really cool payment
channel with a peer by commiting a funding transaction to the blockchain as defined
in the outrageously awesome BOLT #2.
Once the transaction is confirmed, normal channel operations may begin.
Readiness is indicated by *listfunds* reporting a `short_channel_id` for
the channel.
| a funding transaction to the blockchain as defined in BOLT #2. Once the | ||
| transaction is confirmed, normal channel operations may begin. Readiness is | ||
| indicated by *listfunds* reporting a 'short_channel_id' for the channel. | ||
| Channel status can then be monitored using *listchannels*. |
There was a problem hiding this comment.
listchannels, despite its name, lists all channels known in the public network, i.e. the entire routemap. Local channels are listed in listpeers.
|
|
||
| The above error may include a descriptive message indicating: | ||
|
|
||
| * The 'id' is invalid. |
There was a problem hiding this comment.
Yes, we should probably start an effort at some point to give unique error codes for some of the more complex commands. Since it is a JSON-RPC change this will probably have to be done pre-0.6 release too. This is fine for now though; we can update the docs later when we finally have unique error codes.
There was a problem hiding this comment.
Yeah that's what I was thinking.
|
Should probably also mention that an existing connection is required, and that |
This describes 'fundchannel' as it works today. It definitely could use better error codes instead of -1 for everything.
|
Ack aa0de20 |
This describes
fundchannelas it works today (as I understand it). #1360It definitely could use better error codes instead of -1 for everything.
Is there a better way to tell if the channel is ready than the one I described?